home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / INDEX.PY < prev    next >
Encoding:
Python Source  |  1999-05-13  |  10.3 KB  |  338 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85.  
  86. """Simple column indices"""
  87. __version__='$Revision: 1.26 $'[11:-2]
  88.  
  89. from Globals import Persistent
  90. from BTree import BTree
  91. from intSet import intSet
  92. import operator
  93. from Missing import MV
  94. import string
  95.  
  96. ListType=type([])
  97. StringType=type('s')
  98.  
  99.  
  100. def nonEmpty(s):
  101.     "returns true if a non-empty string or any other (nonstring) type"
  102.     if type(s) is StringType:
  103.         if s: return 1
  104.         else: return 0
  105.     else:
  106.         return 1
  107.  
  108.  
  109. class Index(Persistent):
  110.     """Index object interface"""
  111.  
  112.     def __init__(self, data=None, schema=None, id=None,
  113.                  ignore_ex=None, call_methods=None):
  114.         """Create an index
  115.  
  116.         The arguments are:
  117.  
  118.           'data' -- a mapping from integer object ids to objects or
  119.           records,
  120.  
  121.           'schema' -- a mapping from item name to index into data
  122.           records.  If 'data' is a mapping to objects, then schema
  123.           should ne 'None'.
  124.  
  125.           'id' -- the name of the item attribute to index.  This is
  126.           either an attribute name or a record key.
  127.  
  128.         """
  129.     ######################################################################
  130.     # For b/w compatability, have to allow __init__ calls with zero args
  131.  
  132.         if not data==schema==id==ignore_ex==call_methods==None:
  133.             self._data = data
  134.             self._schema = schema
  135.             self.id = id
  136.             self.ignore_ex=ignore_ex
  137.             self.call_methods=call_methods
  138.             self._index = BTree()
  139.             
  140.             self._reindex()
  141.         else:
  142.             pass
  143.  
  144.     # for b/w compatability
  145.     _init = __init__
  146.  
  147.  
  148.     def dpHasUniqueValuesFor(self, name):
  149.         ' has unique values for column NAME '
  150.         if name == self.id:
  151.             return 1
  152.         else:
  153.             return 0
  154.  
  155.  
  156.     def dpUniqueValues(self, name=None, withLengths=0):
  157.         """\
  158.         returns the unique values for name
  159.  
  160.         if withLengths is true, returns a sequence of
  161.         tuples of (value, length)
  162.         """
  163.         if name is None:
  164.             name = self.id
  165.         elif name != self.id:
  166.             return []
  167.         if not withLengths: return tuple(
  168.             filter(nonEmpty,self._index.keys())
  169.             )
  170.         else: 
  171.             rl=[]
  172.             for i in self._index.keys():
  173.                 if not nonEmpty(i): continue
  174.                 else: rl.append((i, len(self._index[i])))
  175.             return tuple(rl)
  176.  
  177.  
  178.     def clear(self):
  179.         self._index = BTree()
  180.  
  181.  
  182.     def _reindex(self, start=0):
  183.         """Recompute index data for data with ids >= start."""
  184.  
  185.         index=self._index
  186.         get=index.get
  187.         
  188.         if not start: index.clear()
  189.  
  190.         id = self.id
  191.         if self._schema is None:
  192.             f=getattr
  193.         else:
  194.             f = operator.__getitem__
  195.             id = self._schema[id]
  196.  
  197.         for i,row in self._data.items(start):
  198.             k=f(row,id)
  199.  
  200.             if k is None or k == MV: continue
  201.  
  202.             set=get(k)
  203.             if set is None: index[k] = set = intSet()
  204.             set.insert(i)
  205.  
  206.  
  207.     def index_item(self, i, obj=None):
  208.         """Recompute index data for data with ids >= start."""
  209.         index = self._index
  210.         id = self.id
  211.         if (self._schema is None) or (obj is not None):
  212.             f = getattr
  213.         else:
  214.             f = operator.__getitem__
  215.             id = self._schema[id]
  216.  
  217.         if obj is None:
  218.             obj = self._data[i]
  219.  
  220.         try:    k=f(obj, id)
  221.         except: return
  222.         if self.call_methods:
  223.             k=k()
  224.         if k is None or k == MV:
  225.             return
  226.  
  227.         set = index.get(k)
  228.         if set is None: index[k] = set = intSet()
  229.         set.insert(i)
  230.  
  231.  
  232.     def unindex_item(self, i, obj=None):
  233.         """Recompute index data for data with ids >= start."""
  234.         index = self._index
  235.         id = self.id
  236.         if self._schema is None:
  237.             f = getattr
  238.         else:
  239.             f = operator.__getitem__
  240.             id = self._schema[id]
  241.         if obj is None:
  242.             obj = self._data[i]
  243.  
  244.         try:    k=f(obj, id)
  245.         except: return
  246.         if self.call_methods:
  247.             k=k()
  248.         if k is None or k == MV:
  249.             return
  250.  
  251.         set = index.get(k)
  252.         if set is not None: set.remove(i)
  253.  
  254.  
  255.     def _apply_index(self, request, cid=''): 
  256.         """Apply the index to query parameters given in the argument,
  257.         request
  258.  
  259.         The argument should be a mapping object.
  260.  
  261.         If the request does not contain the needed parameters, then
  262.         None is returned.
  263.  
  264.         If the request contains a parameter with the name of the
  265.         column + '_usage', it is sniffed for information on how to
  266.         handle applying the index.
  267.  
  268.         Otherwise two objects are returned.  The first object is a
  269.         ResultSet containing the record numbers of the matching
  270.         records.  The second object is a tuple containing the names of
  271.         all data fields used.
  272.  
  273.         """
  274.         id = self.id              #name of the column
  275.  
  276.         cidid = "%s/%s" % (cid,id)
  277.         has_key = request.has_key
  278.         if has_key(cidid): keys = request[cidid]
  279.         elif has_key(id): keys = request[id]
  280.         else: return None
  281.  
  282.         if type(keys) is not ListType: keys=[keys]
  283.         index = self._index
  284.         r = None
  285.         anyTrue = 0
  286.         opr = None
  287.  
  288.         if request.has_key(id+'_usage'):
  289.             # see if any usage params are sent to field
  290.             opr=string.split(string.lower(request[id+"_usage"]),':')
  291.             opr, opr_args=opr[0], opr[1:]
  292.  
  293.         if opr=="range":
  294.             if 'min' in opr_args: lo = min(keys)
  295.             else: lo = None
  296.             if 'max' in opr_args: hi = max(keys)
  297.             else: hi = None
  298.  
  299.             anyTrue=1
  300.             try:
  301.                 if hi: setlist = index.items(lo,hi)
  302.                 else:  setlist = index.items(lo)
  303.                 for k,set in setlist:
  304.                     if r is None: r = set
  305.                     else: r = r.union(set)
  306.             except KeyError: pass
  307.         else:           #not a range
  308.             get = index.get
  309.             for key in keys:
  310.                 if key: anyTrue = 1
  311.                 set=get(key)
  312.                 if set is not None:
  313.                     if r is None: r = set
  314.                     else: r = r.union(set)
  315.  
  316.         if r is None:
  317.             if anyTrue: r=intSet()
  318.             else: return None
  319.  
  320.         return r, (id,)
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.